home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Commodities / ClipAid / ClipAid.doc < prev    next >
Text File  |  1996-09-26  |  6KB  |  130 lines
  1.                                 ClipAid(c) v1.0
  2.         
  3.                                       by
  4.  
  5.                                    Rui Lopes
  6.  
  7.  
  8.      This program is Freeware.  Use it to your heart's content and don't
  9. feel guilty that you haven't paid anything for it.  I do, however, retain
  10. the copyright to ClipAid.  The INTACT and UNMODIFIED archive may be 
  11. distributed by any non-profit means (in other words, I don't want you making
  12. money off my work).     
  13.  
  14.  
  15.      ClipAid is a commodity (ie. can only be used with Kickstart 2.0 or 
  16. greater) that adds extra functionality to the Shell.  It allows you to 
  17. highlight filenames and then perform some action on them.  The supported
  18. actions in this version are delete and show, but many more can be easily 
  19. added (and will be in later versions if there is enough interest).  What 
  20. possible use is this, you ask?  Well, to some of you it may be of no use, 
  21. but to people like me who still use the Shell a lot it helps by reducing
  22. the amount of typing that I have to do.
  23.  
  24.     Before you begin using ClipAid there are some important settings that
  25. may have to be adjusted.  All modifications to ClipAid's behavior are done
  26. by changing various ToolTypes.  ClipAid's  ToolTypes are found by 
  27. single-clicking the ClipAid icon then selecting Information in the Icon menu
  28. on the Workbench window.  With the exception of SHOW_ACTION all ToolTypes are
  29. optional; if you don't specify them then the internal default will be used.
  30. The following is a list of ToolTypes with a description of what they do:
  31.  
  32. DELETE_KEY     - the key that (along with the qualifiers Alt and Ctrl)
  33.                  causes the highlighted files to be deleted.  Be careful,
  34.                  there is no checking as to whether you really want them
  35.                  deleted, and I take no responsiblity for any data lost
  36.                  because you accidentally highlighted the wrong file(s).
  37.                  Default is 'd'.
  38.  
  39. SHOW_KEY       - same idea as DELETE_KEY.  Default is 's'.
  40.  
  41. DELETE_ACTION  - this is the Shell command that is executed when the delete
  42.                  hotkey is pressed.  The dollar sign ($) in this ToolType 
  43.                  indicates where the filename(s) will be placed.  Default 
  44.                  is 'SYS:c/delete $ all quiet'.
  45.  
  46. SHOW_ACTION    - same idea as DELETE_ACTION.  There is no default for this
  47.                  action because there is no AmigaDOS command for showing
  48.                  picture files.  Therefore you **MUST DEFINE** this ToolType 
  49.                  to use the show function.  Also, make sure you give the full 
  50.                  path to the show utility that you use, and don't forget to
  51.                  include the dollar sign ($) in place of the filename(s).
  52.  
  53. SEPARATORS     - used to customize ClipAid to the directory listing utility
  54.                  that you use.  When more than one files are selected ClipAid
  55.                  must have a way of separating the entire clip into individual
  56.                  filenames.  This parameter allows you to set what
  57.                  character(s) will be used as splitting delimeters.  For
  58.                  example, the utility I use (dd) places vertical bars (|) 
  59.                  between each file name, which looks like this (the numbers
  60.                  indicate file size):
  61.  
  62.                  foo     23543|bar     235|test    12975
  63.  
  64.                  Therefore, I have put the folllowing into my SEPARATORS
  65.                  ToolType:
  66.  
  67.                  SEPARATORS= |
  68.  
  69.                  Notice that there is also a space between the equals sign
  70.                  (=) and the vertical bar.  This space is also counted as
  71.                  a separator.  Default is ' ' (a single space).
  72.  
  73. EXCLUDE        - used to customize ClipAid.  With this ToolType you can
  74.                  specify particular sequences to ignore.  For example the
  75.                  AmigaDos dir command puts '(dir)' after every directory.
  76.                  Putting the following in the EXCLUDE ToolType will allow
  77.                  ClipAid to process directory names properly:
  78.  
  79.                  EXCLUDE=(dir)
  80.  
  81.                  Multiple exclude strings can be defined by separating them
  82.                  with a vertical bar (|), for example:
  83.  
  84.                  EXCLUDE=foo|bar
  85.  
  86.                  Default is (dir).
  87.  
  88.                - Numbers, by themselves (ie. the filesizes in the above
  89.                  directory output, are automatically excluded.  Numbers inside
  90.                  file/directory names, however, will be retained in the name.
  91.                  For example:
  92.  
  93.                  myfile23   55345|23murky   34322
  94.  
  95.                  The 23's are kept but the other numbers are excluded.
  96.  
  97. CX_PRIORITY    - This is the place where ClipAid will be placed in the 
  98.                  Commodities chain.  Default is 0.
  99.  
  100.  
  101.      Now that ClipAid is set up it's time to put it to work.  I recommend
  102. that you test it in RAM: before you begin using it.  This ensures that the
  103. ToolTypes are set correctly (the defaults are set to AmigaDos' dir command,
  104. so if you want to see what it does use that command to get a directory 
  105. listing). Ok, you've decided that you want to delete a couple of files.  
  106. First,  make sure that your current directory is set to the directory where 
  107. the unwanted files/directories are located.  Second, highlight the unwanted 
  108. files/directories with the mouse, just as you would highlight for a Cut/Paste
  109. operation.  And finally, press Alt-Ctrl-d (or whichever letter is set in the 
  110. DELETE_KEY ToolType).  Do another directory listing and the files/directories
  111. should be gone.  Displaying pictures is done in a similar manner, the only
  112. difference being that the 's' key is pressed instead of the 'd' key.
  113.  
  114.  
  115.      Ok, thats all you need to know to use ClipAid.  If you have any 
  116. problems/bug reports feel free to contact me.  Also don't be afraid to suggest
  117. improvements, I'm not asking for any money so don't be shy about writting me 
  118. a message.  I can be reached at the following places:
  119.  
  120. Devil BBS   User:  Rui Lopes
  121.             Phone: (403) 484-9200
  122.  
  123. Internet    rlopes@worldgate.edmonton.ab.ca
  124.  
  125. Mail        Rui Lopes
  126.             13704 - 70 Street
  127.             Edmonton, Alberta
  128.             T5C 0K9
  129.             Canada
  130.